Get fulfillment option - Fire spark

{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE",
    "channel_ids": ["app", "web", "call-center"]
  }
}

Returns a single fulfillment option for the authenticated merchant. Use this endpoint when you already know the external id and need the current name, type code, and status without listing all options.

Requires an access token with the fulfillment:read scope. See Token to obtain a token.

Path parameters

Parameter	Type	Description
`id`	string	External fulfillment identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. Unique per merchant.

Query parameters

Parameter	Required	Description
`channel_id`	No	External channel identifier. When set, returns 404 unless this fulfillment’s `channel_ids` include the value.

Request

Replace {id} with the external fulfillment identifier.

curl "https://firespark.cloud/api/integrations/v1/fulfillment/delivery?channel_id=app" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

The response wraps one fulfillment object in data.

{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE",
    "channel_ids": ["app", "web", "call-center"]
  }
}

Fulfillment object

Field	Type	Description
`id`	string	External fulfillment identifier. Matches the path parameter.
`uid`	string (UUID)	Fire spark internal identifier.
`merchant_id`	string (UUID)	Merchant the fulfillment option belongs to.
`name`	string	Display name. 1–100 characters.
`type`	string	Fulfillment type code. 1–100 characters. Common values: `DELIVERY`, `PICKUP`, `DINE_IN`. Custom codes are supported.
`status`	string	`ACTIVE` or `INACTIVE`.
`channel_ids`	string[]	External channel identifiers where this fulfillment is available. Empty means inaccessible on every channel.

Error responses

Status	Description
`401`	Missing or invalid access token.
`403`	Token does not include the `fulfillment:read` scope.
`404`	No fulfillment option exists with the given `id`, or it is not available for `channel_id`.